---
title: 工作簿数据结构
icon: NotebookTabs
---

## IWorkbookData

[`IWorkbookData`](https://reference.univer.ai/zh-CN/interfaces/IWorkbookData) 表示 Univer Sheets 中工作簿的快照。

### 属性

| 属性 | 类型 | 描述 |
|----------|------|-------------|
| id | `string` | Univer Sheets 的唯一标识符。 |
| name | `string` | Univer Sheets 的名称。 |
| appVersion | `string` | Univer 模型定义的版本。 |
| locale | `LocaleType` | 文档的语言环境。 |
| styles | `Record<string, Nullable<IStyleData>>` | 工作簿的样式引用。 |
| sheetOrder | `string[]` | 表示工作表顺序的工作表 ID 数组。 |
| sheets | `{ [sheetId: string]: Partial<IWorksheetData> }` | 包含每个工作表数据的记录。 |
| resources? | `IResources` | 存储插件的数据。 |

### 示例

```typescript
const workbookData: IWorkbookData = {
  id: 'unique-workbook-id',
  name: '我的工作簿',
  appVersion: '0.10.2',
  locale: LocaleType.ZH_CN,
  styles: { /* 样式定义 */ },
  sheetOrder: ['sheet1', 'sheet2'],
  sheets: {
    sheet1: { /* 工作表数据 */ },
    sheet2: { /* 工作表数据 */ },
  },
}
```

### 使用

IWorkbookData 是 Univer Sheets 存储数据的对象。主要用于

1. [使用 IWorkbookData 创建 Univer Sheets](/guides/sheets/features/core/sheets-api#create-worksheet)
2. [从 Univer Sheets 中保存 IWorkbookData](/guides/sheets/features/core/sheets-api#get-workbook-data)

`resources` 属性用于存储插件的数据。前往 [插件自定义模型](/guides/recipes/tutorials/custom-model) 了解更多。
